docs(docker): use the default port in docker run command #298
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Docker deployment documentation to use tuwunel’s default internal port in the docker run example, so the port mapping matches the app’s default configuration.
Changes:
- Change
docker runexample port mapping from8448:6167to8448:8008.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```bash | ||
| docker run -d -p 8448:6167 \ | ||
| docker run -d -p 8448:8008 \ |
There was a problem hiding this comment.
This change updates the docker run example to use the default internal port (8008), but the PR description proposes removing all 6167 references. The repo still contains multiple 6167 references in the docker-compose examples and reverse-proxy docs, so either (a) broaden this PR to update those references as well, or (b) narrow/clarify the PR description/scope to just the docker run example to avoid documentation inconsistency for readers switching between docker run and the provided compose files.
1 participant
Summary
This PR addresses an issue in the
docker rundocumentation.Currently, the example command maps the port to
6167, but it's missingTUWUNEL_PORT=6167to override the default port8008.This change fixes the example by aligning it with the default port
8008.tuwunel/src/core/config/mod.rs
Line 3064 in 9416297
Context
I looked into the history of the port configurations.
The very first example in conduit used port
14004(9504727), though the underlying Rocket framework defaulted to8000.The example was later updated from
14004to6167(3bdaf6e).When refactoring to Axum, the default of
8000was maintained (1f7b3fa).With the addition of multi-port support (67b307c), the internal default was changed to
8008, matching Synapse and Dendrite.Proposed Changes
I suppose we can remove all
6167references and update them to the default8008, which makes the docs cleaner.I'm sorry if you have kept
6167on purpose, as you should already noticed this inconsistency.